home *** CD-ROM | disk | FTP | other *** search
/ SPACE 2 / SPACE - Library 2 - Volume 1.iso / utility / 406 / utility2 / readme.st < prev    next >
Text File  |  1989-08-18  |  9KB  |  175 lines
  1. README for Zoo/ST binaries
  2. ==========================
  3.  
  4. Fortunately, Rahul Dhesi has lifted the tight copyright arrangements for the 
  5. ST version of Zoo. Just like the MS-DOS version, he allows distribution of 
  6. binaries WITHOUT sources. I'm strongly convinced this will help making Zoo 
  7. accepted as archiver number 1 in the ST world.
  8.  
  9. Because a lot of people will receive the Zoo package without the sources, 
  10. here you find the implementation notes for Zoo/ST. Additional information can 
  11. be found in README.ST2, supplied with the sources (which are the ultimate 
  12. documentation offcourse).
  13.  
  14. Please read the official Zoo documentation first (the file ZOO.MAN or ZOO.1).
  15. The Zoo implementation for the ST is complete; all features are present, 
  16. except the following:
  17.    -  using Zoo as a filter is not tested (and will probably not work).
  18.    -  the MS-DOS specific Z-archive format is not supported. A Z-archive or 
  19.       tiny archive seems to be an archive containing a single file; it didn't 
  20.       seem worth the effort (and code size) to implement this.
  21.  
  22.  
  23. ST-SPECIFIC FEATURES
  24. Besides solving a couple of bugs in the original Zoo 2.01 sources, I added 
  25. the following features:
  26.  
  27.    -  Zoo/ST accepts both slashes and backslashes as directory separators in 
  28.       all arguments, like:
  29.          zoo a test /src/atari.c \src\zoo.c \src/zoo.h
  30.    -  added TMPDIR support during packing: the temporary file "Z.@@@" is 
  31.       kept in the following directory:
  32.          1. if a dot was specified as modifier, in the current dir;
  33.          2. else, if the environment variable TMPDIR exists, in the directory 
  34.             this variable points to (TMPDIR may contain a drive specifier);
  35.          3. else in the directory where the zoofile itself resides.
  36.       Note: the only time a temporary file is created is during packing, so 
  37.       this is the only case where you could notice a speed increase when 
  38.       TMPDIR points to a RAMdisk.
  39.    -  added a little check to FIZ.TTP: it now prints HEADER when the archive 
  40.       header is processed (before it always printed DIR and some garbage when 
  41.       the header was processed).
  42.    -  Zoo tries to be clever when deciding to wait for any key to return to 
  43.       the desktop. The method used:
  44.          1. IF the environment variable ZOOPAUSE is set and equal to "no"
  45.             THEN don't wait for a key, return immediately;
  46.          2. ELSE  IF the environment variable ZOOPAUSE == "yes" 
  47.                THEN do wait for a keypress;
  48.          3. ELSE (the environment variable ZOOPAUSE is neither "yes" nor "no")
  49.                IF shell seems to be available
  50.                (i.e. if the system var _shell_p (0x4f6) is unequal to 0)
  51.                   THEN do not wait for a key
  52.                   ELSE do wait for a key.
  53.       This seems to be the most flexible way, offering both desktop and shell 
  54.       users intuitive defaults and optional full control by manipulating 
  55.       ZOOPAUSE.
  56.    -  Zoo/ST was compiled with the GREAT Turbo C compiler, v1.0, from 
  57.       Heimsoeth/Borland; it was linked with a propriatary library, which 
  58.       yields much faster code than TC's stdio library. Unfortunately, this 
  59.       library cannot be distributed to the Public Domain.
  60.       Zoo/ST can be linked with TC's library though, provided that the 
  61.       patches described in README.ST2 are applied to the original library.
  62.    -  Zoo/ST's startup code supports the extended parameter passing technique 
  63.       called "xARGV", restricting the length of all arguments only by the 
  64.       available memory. It's obvious that this feature only works when Zoo is 
  65.       started from a shell which also supports this convention 
  66.       (CRAFT/GPshell, gulam, msh).
  67.    -  Zoo/ST has 1 new "expert" command modifier and 2 related new novice 
  68.       command-line options: 
  69.          /         modifier for "a" expert-level command.
  70.                    When one (or more) of the file arguments represent a 
  71.                    directory, the contents of this directory are COMPLETELY 
  72.                    added (i.e. ALL subdirectories, subsubdirectories etc will 
  73.                    be added).
  74.          -backup   novice command.
  75.                    Same as -add, but when any directory is encountered in the 
  76.                    file arguments, this directory will be completely added 
  77.                    (including all subdirectories, subsubdirectories, etc). 
  78.                    All file names are stored completely (i.e. including the 
  79.                    full path).
  80.                    Same as expert command "aP/".
  81.          -restore  novice command.
  82.                    Logical counterpart of the new -backup option. Will 
  83.                    extract files from a Zoo archive using directory 
  84.                    information (if present) and creating any (sub)directory 
  85.                    needed which does not exist.
  86.                    Same as expert command "x//".
  87.       These new features will probably be added to versions of Zoo on other 
  88.       machines as well.
  89.  
  90.  
  91. BUGS
  92. At the moment of distribution, 3 bugs are known:
  93.    1. the Lempel-Ziv compression method fails dramatically when Zoo is 
  94.       feeded with a file containing 2-byte integers in ascending order (e.g. 
  95.       from 0 to 6500). After quite a long time spent in the compression 
  96.       routine, Zoo reports 0% compression though actually the file has 
  97.       increased with around 30-50%!!!
  98.       This bug is also present in ARC/ST v5.21, because identical LZ 
  99.       compression techniques are used.
  100.       Let's hope Rahul Dhesi can solve this bug.
  101.    2. During beta testing, a rare problem was encountered when TurboDos is 
  102.       active and Zoo is used. When you want to archive a couple of files 
  103.       (more than three, all residing on your harddisk or ramdisk) and the 
  104.       target Zoo archive will be stored on floppy, Zoo aborts with 2 bombs. 
  105.       Using a debugger it seems to be TurboDos' mistake: the bus error is 
  106.       caused by an invalid A0 register used as base register in a TurboDos 
  107.       512-byte internal copy loop.
  108.       The bug is reported to Atari (Benelux); as a fix could take quite some 
  109.       time, and Zoo/ST is already late, I've decided to distribute Zoo/ST 
  110.       anyway.
  111.    3. Because the desktop converts all arguments, passed to a TTP program, to 
  112.       uppercase, expert-level commands (which are case-sensitive) will not 
  113.       work properly in this environment. Fix: use novice commands only or 
  114.       start Zoo from your favourite command-line or graphical shell; 
  115.       especially the ZooBoy graphical shell for the Zoo program is highly
  116.       recommended!
  117.       Note: as the case-sensitiveness of the expert-level commands belongs to 
  118.       the fundamentals of Zoo as written by Rahul Dhesi, it seems a bad 
  119.       choice to change the expert-level command bindings. We really have to 
  120.       blame Atari or DR, whoever introduced this "feature"!
  121.  
  122. Other bugs encountered by users can be reported to me (see below) or posted 
  123. to Usenet (comp.sources.bugs or comp.sys.atari.st). Please do report them!
  124.  
  125.  
  126. DISTRIBUTION
  127. Zoo/ST can be distributed in three different ways:
  128.    1. an archive (preferably a Zoo archive, but an ARC archive will reach 
  129.       more people for a start) containing the following files:
  130.  
  131.          ARCVSZOO.TXT   (discussion of ARC vs Zoo)
  132.          COPYRIGH.T     (Official Zoo copyright)
  133.          FIZ.TTP        (FIx Zoo files, a dedicated utility)
  134.          FIZ.MAN        (FIZ documentation)
  135.          README.ST      (this file)
  136.          WHATS.NEW      (latest features/changes in current ST version)
  137.          ZOO.TTP        (Zoo/ST itself)
  138.          ZOO.MAN        (Zoo documentation)
  139.  
  140.    2. an archive containing the complete source as described in the file
  141.       README.NOW, plus the Atari ST-specific README.ST2, ATARI.C & ATARI2.C 
  142.       and all the files listed above.
  143.    3. Thanks to Rahul Dhesi, FIZ.TTP and ZOO.TTP may be distributed 
  144.       separately (although anybody probably needs the documentation).
  145.  
  146.  
  147. Enjoy! (That's what I do...)
  148.  
  149.  
  150. NOTE
  151. Zoo archives can also be listed and extracted with the program Booz 
  152. ("Barebones Ooz"), also by Rahul Dhesi.
  153.  
  154. TIP
  155. A very nice-looking graphical shell (a la ARCSH for ARC), called ZooBoy and 
  156. written by Ernst Blok, is available in the Public Domain. It will be/is 
  157. distributed via comp.binaries.atari.st. If you don't use a command-line 
  158. shell, use this program to pass commands to Zoo: it has a very nice 
  159. user-interface. Highly recommended!
  160.  
  161.  
  162. Daan*                    / .    .
  163.                      __ /
  164.                     (  /  /    /
  165.                    (__/  /    /      (Daan Josephus Jitta)
  166.                         /    /
  167.                      __/  __/
  168.  
  169. old-fashioned:           modern:
  170. --------------           -------
  171. Bos en Lommerweg 10 ii   UUCP:  ...!hp4nl!neabbs!daanjj OR daanjj@neabbs
  172. NL-1055 EB  Amsterdam    Fido:  2:280/1           --   daan jitta
  173. Holland                  Fax:   (+31) 020-763706  --   daan jitta
  174. Tel. (+31) 020-820521    Telex: 12969, NEABS NL, attn: daan jitta
  175.